Documentation Cleanup#2053
Open
ChuckTerry wants to merge 2 commits intoLabelbox:developfrom
Open
Conversation
ChuckTerry
requested review from
KeshavSahoo,
carl-l-chua,
cyrusj89,
golchin-shahriar,
john-labelbox,
ramy1951 and
vedsirdeshmukh
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation Cleaning
I started this to fix a couple of dead links in the root
README.mdbut figured I should go ahead and hit other documentation while I was at it.CONTRIBUTING.md
README.md
Other
README.mdlinks to definition of "Experimental Feature" inlibs/lbox-clientsandlibs/lbox-exampleThis redirected to the overview page and it appears that we no longer define what an experimental feature is in the docs.libs/labelbox/README.md.Type of change
All Submissions
Note
Low Risk
Documentation-only changes (links, headings, formatting) with no runtime or dependency impact; risk is limited to potential broken doc references.
Overview
Fixes and standardizes project documentation by correcting dead/outdated links (API key docs, docs
index.rstpath), normalizing GitHub capitalization, and updating the rootREADME.mdTOC (addsProvenance, removes a stale entry) plus the social badge (Twitter→X).Also improves markdown formatting (adds
python/bashfenced code blocks, minor whitespace/newline fixes) and simplifies the experimental module READMEs by removing a now-invalid link and leaving a short disclaimer.Reviewed by Cursor Bugbot for commit 96f1358. Bugbot is set up for automated code reviews on this repo. Configure here.